'\"
'\" Copyright 1989 Regents of the University of California
'\" Permission to use, copy, modify, and distribute this
'\" documentation for any purpose and without fee is hereby
'\" granted, provided that this notice appears in all copies.
'\" The University of California makes no representations about
'\" the suitability of this material for any purpose.  It is
'\" provided "as is" without express or implied warranty.
'\" 
'\" $Header: /cvsroot/PROCPLACE/pptinytcl/doc/Backslash.3,v 1.1.1.1 2001/04/20 15:03:06 karl Exp $ SPRITE (Berkeley)
'\" 
.so man.macros
.HS Tcl_Backslash tcl
.BS
.SH NAME
Tcl_Backslash \- parse a backslash sequence
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
char
\fBTcl_Backslash\fR(\fIsrc, countPtr\fR)
.SH ARGUMENTS
.AS char *countPtr
.AP char *src in
Pointer to a string starting with a backslash.
.AP int *countPtr out
If \fIcountPtr\fR isn't NULL, \fI*countPtr\fR gets filled
in with number of characters in the backslash sequence, including
the backslash character.
.BE

.SH DESCRIPTION
.PP
This is a utility procedure used by several of the Tcl
commands.  It parses a backslash sequence and returns
the single character corresponding to the sequence.
.VS
If the backslash sequence should be replaced by no character
at all (e.g. backslash-newline) then \fBTcl_Backslash\fR returns 0.
.VE
\fBTcl_Backslash\fR modifies \fI*countPtr\fR to contain the number
of characters in the backslash sequence.
If \fIsrc\fR doesn't point to a backslash
sequence understood by Tcl, then Tcl_Backslash returns a backslash
as its result and \fI*countPtr\fR gets set to 1 (in this case the
backslash character should not get any special treatment).
.PP
See the Tcl manual entry for information on the valid
backslash sequences.
.VS
All of the sequences described in the Tcl
manual entry are supported by \fBTcl_Backslash\fR.
.VE

.SH KEYWORDS
backslash, parse
